LockInformation
in package
implements
ModelInterface, ArrayAccess
LockInformation Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getErrorDetails() : ErrorDetails
- Gets error_details
- getLockDurationInSeconds() : string|null
- Gets lock_duration_in_seconds
- getLockedByApp() : string|null
- Gets locked_by_app
- getLockedByUser() : UserInfo
- Gets locked_by_user
- getLockedUntilDateTime() : string|null
- Gets locked_until_date_time
- getLockToken() : string|null
- Gets lock_token
- getLockType() : string|null
- Gets lock_type
- getModelName() : string
- The original name of the model.
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUseScratchPad() : string|null
- Gets use_scratch_pad
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setErrorDetails() : $this
- Sets error_details
- setLockDurationInSeconds() : $this
- Sets lock_duration_in_seconds
- setLockedByApp() : $this
- Sets locked_by_app
- setLockedByUser() : $this
- Sets locked_by_user
- setLockedUntilDateTime() : $this
- Sets locked_until_date_time
- setLockToken() : $this
- Sets lock_token
- setLockType() : $this
- Sets lock_type
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUseScratchPad() : $this
- Sets use_scratch_pad
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['error_details' => 'errorDetails', 'lock_duration_in_seconds' => 'lockDurationInSeconds', 'locked_by_app' => 'lockedByApp', 'locked_by_user' => 'lockedByUser', 'locked_until_date_time' => 'lockedUntilDateTime', 'lock_token' => 'lockToken', 'lock_type' => 'lockType', 'use_scratch_pad' => 'useScratchPad']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['error_details' => 'getErrorDetails', 'lock_duration_in_seconds' => 'getLockDurationInSeconds', 'locked_by_app' => 'getLockedByApp', 'locked_by_user' => 'getLockedByUser', 'locked_until_date_time' => 'getLockedUntilDateTime', 'lock_token' => 'getLockToken', 'lock_type' => 'getLockType', 'use_scratch_pad' => 'getUseScratchPad']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['error_details' => 'setErrorDetails', 'lock_duration_in_seconds' => 'setLockDurationInSeconds', 'locked_by_app' => 'setLockedByApp', 'locked_by_user' => 'setLockedByUser', 'locked_until_date_time' => 'setLockedUntilDateTime', 'lock_token' => 'setLockToken', 'lock_type' => 'setLockType', 'use_scratch_pad' => 'setUseScratchPad']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['error_details' => null, 'lock_duration_in_seconds' => null, 'locked_by_app' => null, 'locked_by_user' => null, 'locked_until_date_time' => null, 'lock_token' => null, 'lock_type' => null, 'use_scratch_pad' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'lockInformation'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'lock_duration_in_seconds' => '?string', 'locked_by_app' => '?string', 'locked_by_user' => '\\DocuSign\\eSign\\Model\\UserInfo', 'locked_until_date_time' => '?string', 'lock_token' => '?string', 'lock_type' => '?string', 'use_scratch_pad' => '?string']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —getLockDurationInSeconds()
Gets lock_duration_in_seconds
public
getLockDurationInSeconds() : string|null
Return values
string|null —getLockedByApp()
Gets locked_by_app
public
getLockedByApp() : string|null
Return values
string|null —getLockedByUser()
Gets locked_by_user
public
getLockedByUser() : UserInfo
Return values
UserInfo —getLockedUntilDateTime()
Gets locked_until_date_time
public
getLockedUntilDateTime() : string|null
Return values
string|null —getLockToken()
Gets lock_token
public
getLockToken() : string|null
Return values
string|null —getLockType()
Gets lock_type
public
getLockType() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUseScratchPad()
Gets use_scratch_pad
public
getUseScratchPad() : string|null
Return values
string|null —listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
Return values
$this —setLockDurationInSeconds()
Sets lock_duration_in_seconds
public
setLockDurationInSeconds(string|null $lock_duration_in_seconds) : $this
Parameters
- $lock_duration_in_seconds : string|null
-
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.
Return values
$this —setLockedByApp()
Sets locked_by_app
public
setLockedByApp(string|null $locked_by_app) : $this
Parameters
- $locked_by_app : string|null
-
Specifies the friendly name of the application that is locking the envelope.
Return values
$this —setLockedByUser()
Sets locked_by_user
public
setLockedByUser(UserInfo $locked_by_user) : $this
Parameters
- $locked_by_user : UserInfo
-
A complex type containing information about the user that has the envelope or template locked.
Return values
$this —setLockedUntilDateTime()
Sets locked_until_date_time
public
setLockedUntilDateTime(string|null $locked_until_date_time) : $this
Parameters
- $locked_until_date_time : string|null
-
The datetime until the envelope lock expires.
Return values
$this —setLockToken()
Sets lock_token
public
setLockToken(string|null $lock_token) : $this
Parameters
- $lock_token : string|null
-
A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.
Return values
$this —setLockType()
Sets lock_type
public
setLockType(string|null $lock_type) : $this
Parameters
- $lock_type : string|null
-
The type of envelope lock. Currently "edit" is the only supported type.
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setUseScratchPad()
Sets use_scratch_pad
public
setUseScratchPad(string|null $use_scratch_pad) : $this
Parameters
- $use_scratch_pad : string|null
-
Reserved for future use. Indicates whether a scratchpad is used for editing information.
Return values
$this —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid