new module:model/RecipientViewRequest()
- Source:
Constructs a new RecipientViewRequest.
The request body for the EnvelopeViews: createRecipient and EnvelopeViews: createSharedRecipient methods.
Members
(inner) assertionId :String
- Source:
A unique identifier of the authentication event executed by the client application.
Type:
- String
(inner) authenticationInstant :String
- Source:
A sender generated value that indicates the date/time that the signer was authenticated.
Type:
- String
(inner) authenticationMethod :String
- Source:
A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion.
Type:
- String
(inner) clientURLs :module:model/RecipientTokenClientURLs
- Source:
Type:
(inner) clientUserId :String
- Source:
A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters.
Type:
- String
(inner) displayFormat :String
- Source:
Type:
- String
(inner) email :String
- Source:
Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.
Type:
- String
(inner) frameAncestors :Array.<String>
- Source:
Type:
- Array.<String>
(inner) messageOrigins :Array.<String>
- Source:
Type:
- Array.<String>
(inner) pingFrequency :String
- Source:
Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds.
Type:
- String
(inner) pingUrl :String
- Source:
A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received.
Type:
- String
(inner) recipientId :String
- Source:
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
Type:
- String
(inner) returnUrl :String
- Source:
The url the recipient is redirected to after the signing session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your application. Possible event parameter values: * cancel (recipient canceled the signing operation) * decline (recipient declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax pending) * session_timeout (session timed out) * signing_complete (signer completed the signing ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers.
Type:
- String
(inner) securityDomain :String
- Source:
The domain in which the user authenticated.
Type:
- String
(inner) userId :String
- Source:
Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. If user ID is used and a client user ID is provided, the value in the userId property must match a recipient ID (which can be retrieved with a GET recipients call) for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match the user ID of the authenticating user.
Type:
- String
(inner) userName :String
- Source:
Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient.
Type:
- String
(inner) xFrameOptions :String
- Source:
Type:
- String
(inner) xFrameOptionsAllowFromUrl :String
- Source:
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/RecipientViewRequest}
- Source:
Constructs a RecipientViewRequest 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/RecipientViewRequest | Optional instance to populate. |
Returns:
The populated RecipientViewRequest instance.