DocuSign.eSign.Model.ConsoleViewRequest Class Reference

The request object for the EnvelopeViews: createConsole method. More...

Inheritance diagram for DocuSign.eSign.Model.ConsoleViewRequest:

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

Properties
string	EnvelopeId [get, set]
	The envelope ID of the envelope status that failed to post. More...
string	ReturnUrl [get, set]
	The URL to be redirected to after the console view session has ended. More...

Detailed Description

The request object for the EnvelopeViews: createConsole method.

Constructor & Destructor Documentation

ConsoleViewRequest()

DocuSign.eSign.Model.ConsoleViewRequest.ConsoleViewRequest ( string  EnvelopeId = default(string), string  ReturnUrl = default(string)  )

inline

Initializes a new instance of the ConsoleViewRequest class.

Parameters

EnvelopeId	The envelope ID of the envelope status that failed to post..
ReturnUrl	The URL to be redirected to after the console view session has ended..

Member Function Documentation

Equals() [1/2]

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

inline

Returns true if ConsoleViewRequest instances are equal

Parameters

other

Instance of ConsoleViewRequest to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inline

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

EnvelopeId

string DocuSign.eSign.Model.ConsoleViewRequest.EnvelopeId

getset

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

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

ReturnUrl

string DocuSign.eSign.Model.ConsoleViewRequest.ReturnUrl

getset

The URL to be redirected to after the console view session has ended.

The URL to be redirected to after the console view session has ended.

---

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

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