Documentation

CustomFieldV2
in package
implements ArrayAccess

CustomFieldV2 Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

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)
$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()  : mixed
getConfigurationType()  : string
Gets configuration_type
getErrorDetails()  : ErrorDetails
Gets error_details
getFieldId()  : string
Gets field_id
getName()  : string
Gets name
getRequired()  : string
Gets required
getShow()  : string
Gets show
getters()  : mixed
getValue()  : string
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()  : mixed
setValue()  : $this
Sets value
swaggerTypes()  : mixed
valid()  : bool
validate all the properties in the model return true if all passed

Constants

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']

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'customField_v2'

$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()

public static attributeMap() : mixed
Return values
mixed

getConfigurationType()

Gets configuration_type

public getConfigurationType() : string
Return values
string

getFieldId()

Gets field_id

public getFieldId() : string
Return values
string

getName()

Gets name

public getName() : string
Return values
string

getRequired()

Gets required

public getRequired() : string
Return values
string

getShow()

Gets show

public getShow() : string
Return values
string

getters()

public static getters() : mixed
Return values
mixed

getValue()

Gets value

public getValue() : string
Return values
string

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 $configuration_type) : $this
Parameters
$configuration_type : string

If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

Return values
$this

setFieldId()

Sets field_id

public setFieldId(string $field_id) : $this
Parameters
$field_id : string
Return values
$this

setName()

Sets name

public setName(string $name) : $this
Parameters
$name : string
Return values
$this

setRequired()

Sets required

public setRequired(string $required) : $this
Parameters
$required : string

When set to true, the signer is required to fill out this tab

Return values
$this

setShow()

Sets show

public setShow(string $show) : $this
Parameters
$show : string
Return values
$this

setters()

public static setters() : mixed
Return values
mixed

setValue()

Sets value

public setValue(string $value) : $this
Parameters
$value : string

The value of the custom field.

Return values
$this

swaggerTypes()

public static swaggerTypes() : mixed
Return values
mixed

valid()

validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool

True if all properteis are valid

Search results