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

The request body for the EnvelopeViews: createCorrect method. More...

Inheritance diagram for DocuSign.eSign.Model.CorrectViewRequest:

Public Member Functions

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

Properties

string BeginOnTagger [get, set]
 Gets or Sets BeginOnTagger More...
 
string ReturnUrl [get, set]
 The url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. The event parameters returned are: * send (user corrected and sent the envelope) * save (user saved the envelope) * cancel (user canceled the transaction.) * error (there was an error when performing the correct or send) * sessionEnd (the session ended before the user completed a different action) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. More...
 
string SuppressNavigation [get, set]
 Specifies whether the window is displayed with or without dressing. More...
 
string ViewUrl [get, set]
 Gets or Sets ViewUrl More...
 

Detailed Description

The request body for the EnvelopeViews: createCorrect method.

Constructor & Destructor Documentation

◆ CorrectViewRequest()

DocuSign.eSign.Model.CorrectViewRequest.CorrectViewRequest ( string  BeginOnTagger = default(string),
string  ReturnUrl = default(string),
string  SuppressNavigation = default(string),
string  ViewUrl = default(string) 
)
inline

Initializes a new instance of the CorrectViewRequest class.

Parameters
BeginOnTaggerBeginOnTagger.
ReturnUrlThe url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. The event parameters returned are: * send (user corrected and sent the envelope) * save (user saved the envelope) * cancel (user canceled the transaction.) * error (there was an error when performing the correct or send) * sessionEnd (the session ended before the user completed a different action) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. .
SuppressNavigationSpecifies whether the window is displayed with or without dressing..
ViewUrlViewUrl.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if CorrectViewRequest instances are equal

Parameters
otherInstance of CorrectViewRequest to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ BeginOnTagger

string DocuSign.eSign.Model.CorrectViewRequest.BeginOnTagger
getset

Gets or Sets BeginOnTagger

◆ ReturnUrl

string DocuSign.eSign.Model.CorrectViewRequest.ReturnUrl
getset

The url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. The event parameters returned are: * send (user corrected and sent the envelope) * save (user saved the envelope) * cancel (user canceled the transaction.) * error (there was an error when performing the correct or send) * sessionEnd (the session ended before the user completed a different action) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers.

The url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. The event parameters returned are: * send (user corrected and sent the envelope) * save (user saved the envelope) * cancel (user canceled the transaction.) * error (there was an error when performing the correct or send) * sessionEnd (the session ended before the user completed a different action) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers.

◆ SuppressNavigation

string DocuSign.eSign.Model.CorrectViewRequest.SuppressNavigation
getset

Specifies whether the window is displayed with or without dressing.

Specifies whether the window is displayed with or without dressing.

◆ ViewUrl

string DocuSign.eSign.Model.CorrectViewRequest.ViewUrl
getset

Gets or Sets ViewUrl


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