new module:model/LockInformation()
- Source:
Constructs a new LockInformation.
Members
(inner) errorDetails :module:model/ErrorDetails
- Source:
Array or errors.
Type:
(inner) lockDurationInSeconds :String
- Source:
Sets the time, in seconds, until the lock expires when there is no activity on the envelope. If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds. The lock duration can be extended.
Type:
- String
(inner) lockedByApp :String
- Source:
Specifies the friendly name of the application that is locking the envelope.
Type:
- String
(inner) lockedByUser :module:model/UserInfo
- Source:
A complex type containing information about the user that has the envelope or template locked.
Type:
(inner) lockedUntilDateTime :String
- Source:
The datetime until the envelope lock expires.
Type:
- String
(inner) lockToken :String
- Source:
A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.
Type:
- String
(inner) lockType :String
- Source:
The type of envelope lock. Currently "edit" is the only supported type.
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/LockInformation}
- Source:
Constructs a LockInformation 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/LockInformation | Optional instance to populate. |
Returns:
The populated LockInformation instance.