new module:model/LockRequest()
- Source:
Constructs a new LockRequest.
This request object contains information about the lock that you want to create or update.
Members
(inner) lockDurationInSeconds :String
- Source:
The number of seconds to lock the envelope for editing. Must be greater than 0 seconds.
Type:
- String
(inner) lockedByApp :String
- Source:
A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
Type:
- String
(inner) lockType :String
- Source:
The type of envelope lock. Currently "edit" is the only supported type.
Type:
- String
(inner) templatePassword :String
- Source:
Type:
- String
(inner) useScratchPad :String
- Source:
Reserved for future use. Indicates whether a scratchpad is used for editing information.
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/LockRequest}
- Source:
Constructs a LockRequest 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/LockRequest | Optional instance to populate. |
Returns:
The populated LockRequest instance.