TextCustomField
in package
implements
ModelInterface, ArrayAccess
TextCustomField 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
- getConfigurationType() : string|null
- Gets configuration_type
- getErrorDetails() : ErrorDetails
- Gets error_details
- getFieldId() : string|null
- Gets field_id
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getRequired() : string|null
- Gets required
- getShow() : string|null
- Gets show
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getValue() : string|null
- Gets value
- 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.
- setConfigurationType() : $this
- Sets configuration_type
- setErrorDetails() : $this
- Sets error_details
- setFieldId() : $this
- Sets field_id
- setName() : $this
- Sets name
- setRequired() : $this
- Sets required
- setShow() : $this
- Sets show
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setValue() : $this
- Sets value
- 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
= ['configuration_type' => 'configurationType', 'error_details' => 'errorDetails', 'field_id' => 'fieldId', 'name' => 'name', 'required' => 'required', 'show' => 'show', 'value' => 'value']
$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
= ['configuration_type' => 'getConfigurationType', 'error_details' => 'getErrorDetails', 'field_id' => 'getFieldId', 'name' => 'getName', 'required' => 'getRequired', 'show' => 'getShow', 'value' => 'getValue']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['configuration_type' => 'setConfigurationType', 'error_details' => 'setErrorDetails', 'field_id' => 'setFieldId', 'name' => 'setName', 'required' => 'setRequired', 'show' => 'setShow', 'value' => 'setValue']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['configuration_type' => null, 'error_details' => null, 'field_id' => null, 'name' => null, 'required' => null, 'show' => null, 'value' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'textCustomField'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['configuration_type' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'field_id' => '?string', 'name' => '?string', 'required' => '?string', 'show' => '?string', 'value' => '?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> —getConfigurationType()
Gets configuration_type
public
getConfigurationType() : string|null
Return values
string|null —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —getFieldId()
Gets field_id
public
getFieldId() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getRequired()
Gets required
public
getRequired() : string|null
Return values
string|null —getShow()
Gets show
public
getShow() : 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> —getValue()
Gets value
public
getValue() : 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 —setConfigurationType()
Sets configuration_type
public
setConfigurationType(string|null $configuration_type) : $this
Parameters
- $configuration_type : string|null
-
If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.
Return values
$this —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
Return values
$this —setFieldId()
Sets field_id
public
setFieldId(string|null $field_id) : $this
Parameters
- $field_id : string|null
-
An ID used to specify a custom field.
Return values
$this —setName()
Sets name
public
setName(string|null $name) : $this
Parameters
- $name : string|null
-
The name of the custom field.
Return values
$this —setRequired()
Sets required
public
setRequired(string|null $required) : $this
Parameters
- $required : string|null
-
When set to true, the signer is required to fill out this tab
Return values
$this —setShow()
Sets show
public
setShow(string|null $show) : $this
Parameters
- $show : string|null
-
A boolean indicating if the value should be displayed.
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> —setValue()
Sets value
public
setValue(string|null $value) : $this
Parameters
- $value : string|null
-
The value of the custom field.
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