module:model/ReturnUrlRequest

module:model/ReturnUrlRequest

new module:model/ReturnUrlRequest()

Source:

Constructs a new ReturnUrlRequest.
The request body for the EnvelopeViews: createSender method.

Members

(inner) returnUrl :String

Source:

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).

Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/ReturnUrlRequest}

Source:

Constructs a ReturnUrlRequest from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:model/ReturnUrlRequest

Optional instance to populate.

Returns:

The populated ReturnUrlRequest instance.

Type
module:model/ReturnUrlRequest