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

For which envelope events should your webhook be called? More...

Inheritance diagram for DocuSign.eSign.Model.EnvelopeEvent:

Public Member Functions

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

Properties

string EnvelopeEventStatusCode [get, set]
 he envelope status, this can be Sent, Delivered, Completed, Declined, or Voided. More...
 
string IncludeDocuments [get, set]
 When set to true, the PDF documents are included in the message along with the updated XML. More...
 

Detailed Description

For which envelope events should your webhook be called?

Constructor & Destructor Documentation

◆ EnvelopeEvent()

DocuSign.eSign.Model.EnvelopeEvent.EnvelopeEvent ( string  EnvelopeEventStatusCode = default(string),
string  IncludeDocuments = default(string) 
)
inline

Initializes a new instance of the EnvelopeEvent class.

Parameters
EnvelopeEventStatusCodehe envelope status, this can be Sent, Delivered, Completed, Declined, or Voided..
IncludeDocumentsWhen set to true, the PDF documents are included in the message along with the updated XML. .

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if EnvelopeEvent instances are equal

Parameters
otherInstance of EnvelopeEvent to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ EnvelopeEventStatusCode

string DocuSign.eSign.Model.EnvelopeEvent.EnvelopeEventStatusCode
getset

he envelope status, this can be Sent, Delivered, Completed, Declined, or Voided.

he envelope status, this can be Sent, Delivered, Completed, Declined, or Voided.

◆ IncludeDocuments

string DocuSign.eSign.Model.EnvelopeEvent.IncludeDocuments
getset

When set to true, the PDF documents are included in the message along with the updated XML.

When set to true, the PDF documents are included in the message along with the updated XML.


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