DocuSign.eSign.Model.EnvelopeSummary Class Reference

This object describes an envelope. More...

Inheritance diagram for DocuSign.eSign.Model.EnvelopeSummary:

Public Member Functions
	EnvelopeSummary (BulkEnvelopeStatus BulkEnvelopeStatus=default(BulkEnvelopeStatus), string EnvelopeId=default(string), ErrorDetails ErrorDetails=default(ErrorDetails), string RecipientSigningUri=default(string), string RecipientSigningUriError=default(string), string Status=default(string), string StatusDateTime=default(string), string Uri=default(string))
	Initializes a new instance of the EnvelopeSummary 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 (EnvelopeSummary other)
	Returns true if EnvelopeSummary instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...
IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
BulkEnvelopeStatus	BulkEnvelopeStatus [get, set]
	An object that describes the status of the bulk send envelopes. More...
string	EnvelopeId [get, set]
	The envelope ID of the envelope status that failed to post. More...
ErrorDetails	ErrorDetails [get, set]
	Array or errors. More...
string	RecipientSigningUri [get, set]
	Gets or Sets RecipientSigningUri More...
string	RecipientSigningUriError [get, set]
	Gets or Sets RecipientSigningUriError More...
string	Status [get, set]
	Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. More...
string	StatusDateTime [get, set]
	The DateTime that the envelope changed status (i.e. was created or sent.) More...
string	Uri [get, set]
	Gets or Sets Uri More...

Detailed Description

This object describes an envelope.

Constructor & Destructor Documentation

EnvelopeSummary()

DocuSign.eSign.Model.EnvelopeSummary.EnvelopeSummary ( BulkEnvelopeStatus  BulkEnvelopeStatus = default(BulkEnvelopeStatus), string  EnvelopeId = default(string), ErrorDetails  ErrorDetails = default(ErrorDetails), string  RecipientSigningUri = default(string), string  RecipientSigningUriError = default(string), string  Status = default(string), string  StatusDateTime = default(string), string  Uri = default(string)  )

inline

Initializes a new instance of the EnvelopeSummary class.

Parameters

BulkEnvelopeStatus	An object that describes the status of the bulk send envelopes..
EnvelopeId	The envelope ID of the envelope status that failed to post..
ErrorDetails	Array or errors..
RecipientSigningUri	RecipientSigningUri.
RecipientSigningUriError	RecipientSigningUriError.
Status	Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..
StatusDateTime	The DateTime that the envelope changed status (i.e. was created or sent.).
Uri	Uri.

Member Function Documentation

Equals() [1/2]

override bool DocuSign.eSign.Model.EnvelopeSummary.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.EnvelopeSummary.Equals ( EnvelopeSummary  other )

inline

Returns true if EnvelopeSummary instances are equal

Parameters

other

Instance of EnvelopeSummary to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inline

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

BulkEnvelopeStatus

BulkEnvelopeStatus DocuSign.eSign.Model.EnvelopeSummary.BulkEnvelopeStatus

getset

An object that describes the status of the bulk send envelopes.

An object that describes the status of the bulk send envelopes.

EnvelopeId

string DocuSign.eSign.Model.EnvelopeSummary.EnvelopeId

getset

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

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

ErrorDetails

ErrorDetails DocuSign.eSign.Model.EnvelopeSummary.ErrorDetails

getset

Array or errors.

Array or errors.

RecipientSigningUri

string DocuSign.eSign.Model.EnvelopeSummary.RecipientSigningUri

getset

Gets or Sets RecipientSigningUri

RecipientSigningUriError

string DocuSign.eSign.Model.EnvelopeSummary.RecipientSigningUriError

getset

Gets or Sets RecipientSigningUriError

Status

string DocuSign.eSign.Model.EnvelopeSummary.Status

getset

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

StatusDateTime

string DocuSign.eSign.Model.EnvelopeSummary.StatusDateTime

getset

The DateTime that the envelope changed status (i.e. was created or sent.)

The DateTime that the envelope changed status (i.e. was created or sent.)

Uri

string DocuSign.eSign.Model.EnvelopeSummary.Uri

getset

Gets or Sets Uri

---

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

• sdk/src/DocuSign.eSign/Model/EnvelopeSummary.cs