new module:model/UserAgreementRequest()
- Source:
Constructs a new UserAgreementRequest.
Data used to create the agreement.
Members
(inner) clientUserId :String
- Source:
A unique value that identifies a user. You can use anything that your system uses to identify unique users, such as employee IDs, email addresses, and surrogate keys as the value of clientUserId. A clickwrap with a specific clientUserId will not appear again once it has been accepted.
Type:
- String
(inner) documentData :Object.<String, String>
- Source:
This property specifies the data used to create a clickwrap with [dynamic content][]. [dynamic content]: /docs/click-api/click101/customize-clickwrap-fields/#embed-clickwraps-that-contain-dynamic-content
Type:
- Object.<String, String>
(inner) metadata :String
- Source:
A customer-defined string you can use in requests. This string will appear in the corresponding response.
Type:
- String
(inner) returnUrl :String
- Source:
The URL to redirect to after the agreement is complete when the agreement is not rendered in an iframe.
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/UserAgreementRequest}
- Source:
Constructs a UserAgreementRequest 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/UserAgreementRequest | Optional instance to populate. |
Returns:
The populated UserAgreementRequest instance.