LockRequest
in package
implements
ModelInterface, ArrayAccess
LockRequest 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
- getLockDurationInSeconds() : string|null
- Gets lock_duration_in_seconds
- getLockedByApp() : string|null
- Gets locked_by_app
- getLockType() : string|null
- Gets lock_type
- getModelName() : string
- The original name of the model.
- getTemplatePassword() : string|null
- Gets template_password
- 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.
- setLockDurationInSeconds() : $this
- Sets lock_duration_in_seconds
- setLockedByApp() : $this
- Sets locked_by_app
- setLockType() : $this
- Sets lock_type
- setTemplatePassword() : $this
- Sets template_password
- 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
= ['lock_duration_in_seconds' => 'lockDurationInSeconds', 'locked_by_app' => 'lockedByApp', 'lock_type' => 'lockType', 'template_password' => 'templatePassword', '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
= ['lock_duration_in_seconds' => 'getLockDurationInSeconds', 'locked_by_app' => 'getLockedByApp', 'lock_type' => 'getLockType', 'template_password' => 'getTemplatePassword', 'use_scratch_pad' => 'getUseScratchPad']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['lock_duration_in_seconds' => 'setLockDurationInSeconds', 'locked_by_app' => 'setLockedByApp', 'lock_type' => 'setLockType', 'template_password' => 'setTemplatePassword', 'use_scratch_pad' => 'setUseScratchPad']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['lock_duration_in_seconds' => null, 'locked_by_app' => null, 'lock_type' => null, 'template_password' => null, 'use_scratch_pad' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'lockRequest'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['lock_duration_in_seconds' => '?string', 'locked_by_app' => '?string', 'lock_type' => '?string', 'template_password' => '?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> —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 —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 —getTemplatePassword()
Gets template_password
public
getTemplatePassword() : string|null
Return values
string|null —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 —setLockDurationInSeconds()
Sets lock_duration_in_seconds
public
setLockDurationInSeconds(string|null $lock_duration_in_seconds) : $this
Parameters
- $lock_duration_in_seconds : string|null
-
The number of seconds to lock the envelope for editing. Must be greater than 0 seconds.
Return values
$this —setLockedByApp()
Sets locked_by_app
public
setLockedByApp(string|null $locked_by_app) : $this
Parameters
- $locked_by_app : string|null
-
A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
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 —setTemplatePassword()
Sets template_password
public
setTemplatePassword(string|null $template_password) : $this
Parameters
- $template_password : string|null
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