new module:model/DisplaySettings()
- Source:
Constructs a new DisplaySettings.
Information about how an agreement is displayed.
Members
(inner) actionButtonAlignment :String
- Source:
Position of the Accept button in the agreement. One of - right - left
Type:
- String
(inner) allowClientOnly :Boolean
- Source:
When true, this agreement can be be used in client-only integrations.
Type:
- Boolean
(inner) allowedHosts :Array.<String>
- Source:
Hosts that can host the clickwrap. It is an error if the clickwrap didn't come from one of these hosts.
Type:
- Array.<String>
(inner) brandId :String
- Source:
The signing brand ID.
Type:
- String
(inner) consentButtonText :String
- Source:
Text on the agree button.
Type:
- String
(inner) consentText :String
- Source:
The statement prefixing the Electronic Record and Signature Disclosure agreement.
Type:
- String
(inner) declineButtonText :String
- Source:
The text on the decline button.
Type:
- String
(inner) displayName :String
- Source:
The display name of the user agreement.
Type:
- String
(inner) documentDisplay :String
- Source:
Display type: link, document or pdf
Type:
- String
(inner) downloadable :Boolean
- Source:
True if the agreement is downloadable.
Type:
- Boolean
(inner) format :String
- Source:
Display format: inline or modal.
Type:
- String
(inner) hasDeclineButton :Boolean
- Source:
True if the agreement has a decline button.
Type:
- Boolean
(inner) mustRead :Boolean
- Source:
True if the user needs to scroll to the end of the document.
Type:
- Boolean
(inner) mustView :Boolean
- Source:
True if the user must view the document.
Type:
- Boolean
(inner) recordDeclineResponses :Boolean
- Source:
When true, this agreement records decline actions.
Type:
- Boolean
(inner) requireAccept :Boolean
- Source:
True if a checkbox is required to accept.
Type:
- Boolean
(inner) sendToEmail :Boolean
- Source:
True if send to email is applicable.
Type:
- Boolean
(inner) statementAlignment :String
- Source:
Position of the agreement statement. One of - top - bottom
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/DisplaySettings}
- Source:
Constructs a DisplaySettings 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/DisplaySettings | Optional instance to populate. |
Returns:
The populated DisplaySettings instance.