DocuSign.eSign.Model.LockRequest Class Reference

This request object contains information about the lock that you want to create or update. More...

Inheritance diagram for DocuSign.eSign.Model.LockRequest:

Public Member Functions
	LockRequest (string LockDurationInSeconds=default(string), string LockedByApp=default(string), string LockType=default(string), string TemplatePassword=default(string), string UseScratchPad=default(string))
	Initializes a new instance of the LockRequest class. More...
override string	ToString ()
	Returns the string presentation of the object More...
string	ToJson ()
	Returns the JSON string presentation of the object More...
override bool	Equals (object obj)
	Returns true if objects are equal More...
bool	Equals (LockRequest other)
	Returns true if LockRequest instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...
IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	LockDurationInSeconds [get, set]
	The number of seconds to lock the envelope for editing. Must be greater than 0 seconds. More...
string	LockedByApp [get, set]
	A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur. More...
string	LockType [get, set]
	The type of envelope lock. Currently "edit" is the only supported type. More...
string	TemplatePassword [get, set]
	Gets or Sets TemplatePassword More...
string	UseScratchPad [get, set]
	Reserved for future use. Indicates whether a scratchpad is used for editing information. More...

Detailed Description

This request object contains information about the lock that you want to create or update.

Constructor & Destructor Documentation

LockRequest()

DocuSign.eSign.Model.LockRequest.LockRequest ( string  LockDurationInSeconds = default(string), string  LockedByApp = default(string), string  LockType = default(string), string  TemplatePassword = default(string), string  UseScratchPad = default(string)  )

inline

Initializes a new instance of the LockRequest class.

Parameters

LockDurationInSeconds	The number of seconds to lock the envelope for editing. Must be greater than 0 seconds..
LockedByApp	A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur..
LockType	The type of envelope lock. Currently "edit" is the only supported type..
TemplatePassword	TemplatePassword.
UseScratchPad	Reserved for future use. Indicates whether a scratchpad is used for editing information. .

Member Function Documentation

Equals() [1/2]

override bool DocuSign.eSign.Model.LockRequest.Equals ( object  obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns

Boolean

Equals() [2/2]

bool DocuSign.eSign.Model.LockRequest.Equals ( LockRequest  other )

inline

Returns true if LockRequest instances are equal

Parameters

other

Instance of LockRequest to be compared

Returns

Boolean

GetHashCode()

override int DocuSign.eSign.Model.LockRequest.GetHashCode ( )

inline

Gets the hash code

Returns

Hash code

ToJson()

string DocuSign.eSign.Model.LockRequest.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

override string DocuSign.eSign.Model.LockRequest.ToString ( )

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

LockDurationInSeconds

string DocuSign.eSign.Model.LockRequest.LockDurationInSeconds

getset

The number of seconds to lock the envelope for editing. Must be greater than 0 seconds.

The number of seconds to lock the envelope for editing. Must be greater than 0 seconds.

LockedByApp

string DocuSign.eSign.Model.LockRequest.LockedByApp

getset

A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.

A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.

LockType

string DocuSign.eSign.Model.LockRequest.LockType

getset

The type of envelope lock. Currently "edit" is the only supported type.

The type of envelope lock. Currently "edit" is the only supported type.

TemplatePassword

string DocuSign.eSign.Model.LockRequest.TemplatePassword

getset

Gets or Sets TemplatePassword

UseScratchPad

string DocuSign.eSign.Model.LockRequest.UseScratchPad

getset

Reserved for future use. Indicates whether a scratchpad is used for editing information.

Reserved for future use. Indicates whether a scratchpad is used for editing information.

---

The documentation for this class was generated from the following file:

• sdk/src/DocuSign.eSign/Model/LockRequest.cs