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

Describes the form data of the envelope. More...

Inheritance diagram for DocuSign.eSign.Model.EnvelopeFormData:

Public Member Functions

 EnvelopeFormData (string EmailSubject=default(string), string EnvelopeId=default(string), List< FormDataItem > FormData=default(List< FormDataItem >), PrefillFormData PrefillFormData=default(PrefillFormData), List< RecipientFormData > RecipientFormData=default(List< RecipientFormData >), string SentDateTime=default(string), string Status=default(string))
 Initializes a new instance of the EnvelopeFormData 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 (EnvelopeFormData other)
 Returns true if EnvelopeFormData instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

string EmailSubject [get, set]
 Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. More...
 
string EnvelopeId [get, set]
 The envelope ID of the envelope status that failed to post. More...
 
List< FormDataItemFormData [get, set]
 Gets or Sets FormData More...
 
PrefillFormData PrefillFormData [get, set]
 An array of &#x60;formDataItem&#x60; objects for prefill tabs. More...
 
List< RecipientFormDataRecipientFormData [get, set]
 Gets or Sets RecipientFormData More...
 
string SentDateTime [get, set]
 The date and time the envelope was sent. 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...
 

Detailed Description

Describes the form data of the envelope.

Constructor & Destructor Documentation

◆ EnvelopeFormData()

DocuSign.eSign.Model.EnvelopeFormData.EnvelopeFormData ( string  EmailSubject = default(string),
string  EnvelopeId = default(string),
List< FormDataItem FormData = default(List<FormDataItem>),
PrefillFormData  PrefillFormData = default(PrefillFormData),
List< RecipientFormData RecipientFormData = default(List<RecipientFormData>),
string  SentDateTime = default(string),
string  Status = default(string) 
)
inline

Initializes a new instance of the EnvelopeFormData class.

Parameters
EmailSubjectSpecifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject..
EnvelopeIdThe envelope ID of the envelope status that failed to post..
FormDataFormData.
PrefillFormDataAn array of &#x60;formDataItem&#x60; objects for prefill tabs. .
RecipientFormDataRecipientFormData.
SentDateTimeThe date and time the envelope was sent..
StatusIndicates 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..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if EnvelopeFormData instances are equal

Parameters
otherInstance of EnvelopeFormData to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ EmailSubject

string DocuSign.eSign.Model.EnvelopeFormData.EmailSubject
getset

Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

◆ EnvelopeId

string DocuSign.eSign.Model.EnvelopeFormData.EnvelopeId
getset

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

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

◆ FormData

List<FormDataItem> DocuSign.eSign.Model.EnvelopeFormData.FormData
getset

Gets or Sets FormData

◆ PrefillFormData

PrefillFormData DocuSign.eSign.Model.EnvelopeFormData.PrefillFormData
getset

An array of &#x60;formDataItem&#x60; objects for prefill tabs.

An array of &#x60;formDataItem&#x60; objects for prefill tabs.

◆ RecipientFormData

List<RecipientFormData> DocuSign.eSign.Model.EnvelopeFormData.RecipientFormData
getset

Gets or Sets RecipientFormData

◆ SentDateTime

string DocuSign.eSign.Model.EnvelopeFormData.SentDateTime
getset

The date and time the envelope was sent.

The date and time the envelope was sent.

◆ Status

string DocuSign.eSign.Model.EnvelopeFormData.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.


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