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

BulkEnvelope More...

Inheritance diagram for DocuSign.eSign.Model.BulkEnvelope:

Public Member Functions

 BulkEnvelope (string BulkRecipientRow=default(string), string BulkStatus=default(string), string Email=default(string), string EnvelopeId=default(string), string EnvelopeUri=default(string), ErrorDetails ErrorDetails=default(ErrorDetails), string Name=default(string), string SubmittedDateTime=default(string), string TransactionId=default(string))
 Initializes a new instance of the BulkEnvelope 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 (BulkEnvelope other)
 Returns true if BulkEnvelope instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

string BulkRecipientRow [get, set]
 Reserved: TBD More...
 
string BulkStatus [get, set]
 Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed More...
 
string Email [get, set]
 Gets or Sets Email More...
 
string EnvelopeId [get, set]
 The envelope ID of the envelope status that failed to post. More...
 
string EnvelopeUri [get, set]
 Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. More...
 
ErrorDetails ErrorDetails [get, set]
 Array or errors. More...
 
string Name [get, set]
 Gets or Sets Name More...
 
string SubmittedDateTime [get, set]
 Gets or Sets SubmittedDateTime More...
 
string TransactionId [get, set]
 Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The &#x60;transactionId&#x60; property can be used determine an envelope&#39;s status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. More...
 

Detailed Description

BulkEnvelope

Constructor & Destructor Documentation

◆ BulkEnvelope()

DocuSign.eSign.Model.BulkEnvelope.BulkEnvelope ( string  BulkRecipientRow = default(string),
string  BulkStatus = default(string),
string  Email = default(string),
string  EnvelopeId = default(string),
string  EnvelopeUri = default(string),
ErrorDetails  ErrorDetails = default(ErrorDetails),
string  Name = default(string),
string  SubmittedDateTime = default(string),
string  TransactionId = default(string) 
)
inline

Initializes a new instance of the BulkEnvelope class.

Parameters
BulkRecipientRowReserved: TBD.
BulkStatusIndicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed.
EmailEmail.
EnvelopeIdThe envelope ID of the envelope status that failed to post..
EnvelopeUriContains a URI for an endpoint that you can use to retrieve the envelope or envelopes..
ErrorDetailsArray or errors..
NameName.
SubmittedDateTimeSubmittedDateTime.
TransactionIdUsed to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The &#x60;transactionId&#x60; property can be used determine an envelope&#39;s status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if BulkEnvelope instances are equal

Parameters
otherInstance of BulkEnvelope to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ BulkRecipientRow

string DocuSign.eSign.Model.BulkEnvelope.BulkRecipientRow
getset

Reserved: TBD

Reserved: TBD

◆ BulkStatus

string DocuSign.eSign.Model.BulkEnvelope.BulkStatus
getset

Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed

Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed

◆ Email

string DocuSign.eSign.Model.BulkEnvelope.Email
getset

Gets or Sets Email

◆ EnvelopeId

string DocuSign.eSign.Model.BulkEnvelope.EnvelopeId
getset

The envelope ID of the envelope status that failed to post.

The envelope ID of the envelope status that failed to post.

◆ EnvelopeUri

string DocuSign.eSign.Model.BulkEnvelope.EnvelopeUri
getset

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

◆ ErrorDetails

ErrorDetails DocuSign.eSign.Model.BulkEnvelope.ErrorDetails
getset

Array or errors.

Array or errors.

◆ Name

string DocuSign.eSign.Model.BulkEnvelope.Name
getset

Gets or Sets Name

◆ SubmittedDateTime

string DocuSign.eSign.Model.BulkEnvelope.SubmittedDateTime
getset

Gets or Sets SubmittedDateTime

◆ TransactionId

string DocuSign.eSign.Model.BulkEnvelope.TransactionId
getset

Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The &#x60;transactionId&#x60; property can be used determine an envelope&#39;s status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.

Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The &#x60;transactionId&#x60; property can be used determine an envelope&#39;s status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.


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