Inheritance diagram for DocuSign.eSign.Model.LockInformation:

Public Member Functions
	LockInformation (ErrorDetails ErrorDetails=default(ErrorDetails), string LockDurationInSeconds=default(string), string LockedByApp=default(string), UserInfo LockedByUser=default(UserInfo), string LockedUntilDateTime=default(string), string LockToken=default(string), string LockType=default(string), string UseScratchPad=default(string))
	Initializes a new instance of the LockInformation 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 (LockInformation other)
	Returns true if LockInformation instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
ErrorDetails	ErrorDetails `[get, set]`
	Array or errors. More...

string	LockDurationInSeconds `[get, set]`
	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. More...

string	LockedByApp `[get, set]`
	Specifies the friendly name of the application that is locking the envelope. More...

UserInfo	LockedByUser `[get, set]`
	A complex type containing information about the user that has the envelope or template locked. More...

string	LockedUntilDateTime `[get, set]`
	The datetime until the envelope lock expires. More...

string	LockToken `[get, set]`
	A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock. More...

string	LockType `[get, set]`
	The type of envelope lock. Currently "edit" is the only supported type. More...

string	UseScratchPad `[get, set]`
	Reserved for future use. Indicates whether a scratchpad is used for editing information. More...

Detailed Description

LockInformation

Constructor & Destructor Documentation

◆ LockInformation()

DocuSign.eSign.Model.LockInformation.LockInformation	(	ErrorDetails	ErrorDetails = `default(ErrorDetails)`,
		string	LockDurationInSeconds = `default(string)`,
		string	LockedByApp = `default(string)`,
		UserInfo	LockedByUser = `default(UserInfo)`,
		string	LockedUntilDateTime = `default(string)`,
		string	LockToken = `default(string)`,
		string	LockType = `default(string)`,
		string	UseScratchPad = `default(string)`
	)

inline

Initializes a new instance of the LockInformation class.

Parameters

ErrorDetails	Array or errors..
LockDurationInSeconds	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. .
LockedByApp	Specifies the friendly name of the application that is locking the envelope..
LockedByUser	A complex type containing information about the user that has the envelope or template locked..
LockedUntilDateTime	The datetime until the envelope lock expires..
LockToken	A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock..
LockType	The type of envelope lock. Currently "edit" is the only supported type..
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.LockInformation.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.LockInformation.Equals ( LockInformation other )

inline

Returns true if LockInformation instances are equal

Parameters

other Instance of LockInformation to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ ErrorDetails

ErrorDetails DocuSign.eSign.Model.LockInformation.ErrorDetails

getset

Array or errors.

◆ LockDurationInSeconds

string DocuSign.eSign.Model.LockInformation.LockDurationInSeconds

getset

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.

◆ LockedByApp

string DocuSign.eSign.Model.LockInformation.LockedByApp

getset

Specifies the friendly name of the application that is locking the envelope.

◆ LockedByUser

UserInfo DocuSign.eSign.Model.LockInformation.LockedByUser

getset

A complex type containing information about the user that has the envelope or template locked.

◆ LockedUntilDateTime

string DocuSign.eSign.Model.LockInformation.LockedUntilDateTime

getset

The datetime until the envelope lock expires.

◆ LockToken

string DocuSign.eSign.Model.LockInformation.LockToken

getset

A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.

◆ LockType

string DocuSign.eSign.Model.LockInformation.LockType

getset

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

◆ UseScratchPad

string DocuSign.eSign.Model.LockInformation.UseScratchPad

getset

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/LockInformation.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ LockInformation()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ ErrorDetails

◆ LockDurationInSeconds

◆ LockedByApp

◆ LockedByUser

◆ LockedUntilDateTime

◆ LockToken

◆ LockType

◆ UseScratchPad