DocuSign.eSign.Model.ReturnUrlRequest Class Reference

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

Inheritance diagram for DocuSign.eSign.Model.ReturnUrlRequest:

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

Properties
string	ReturnUrl [get, set]
	Identifies the return point after sending the envelope. DocuSign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are: * send (user sends the envelope) * save (user saves the envelope) * cancel (user cancels the sending transaction. No envelopeId is returned in this case.) * error (there is an error when performing the send) * sessionEnd (the sending session ends before the user completes another action). More...

Detailed Description

The request body for the EnvelopeViews: createSender method.

Constructor & Destructor Documentation

ReturnUrlRequest()

DocuSign.eSign.Model.ReturnUrlRequest.ReturnUrlRequest ( string  ReturnUrl = default(string) )

inline

Initializes a new instance of the ReturnUrlRequest class.

Parameters

ReturnUrl

Identifies the return point after sending the envelope. DocuSign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are: * send (user sends the envelope) * save (user saves the envelope) * cancel (user cancels the sending transaction. No envelopeId is returned in this case.) * error (there is an error when performing the send) * sessionEnd (the sending session ends before the user completes another action)..

Member Function Documentation

Equals() [1/2]

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

inline

Returns true if ReturnUrlRequest instances are equal

Parameters

other

Instance of ReturnUrlRequest to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inline

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

ReturnUrl

string DocuSign.eSign.Model.ReturnUrlRequest.ReturnUrl

getset

Identifies the return point after sending the envelope. DocuSign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are: * send (user sends the envelope) * save (user saves the envelope) * cancel (user cancels the sending transaction. No envelopeId is returned in this case.) * error (there is an error when performing the send) * sessionEnd (the sending session ends before the user completes another action).

Identifies the return point after sending the envelope. DocuSign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are: * send (user sends the envelope) * save (user saves the envelope) * cancel (user cancels the sending transaction. No envelopeId is returned in this case.) * error (there is an error when performing the send) * sessionEnd (the sending session ends before the user completes another action).

---

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

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