Documentation

DisplayApplianceDocument
in package
implements ArrayAccess

DisplayApplianceDocument 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
getAttachmentDescription()  : string
Gets attachment_description
getDocumentId()  : string
Gets document_id
getDocumentType()  : string
Gets document_type
getEnvelopeId()  : string
Gets envelope_id
getExternalDocumentId()  : string
Gets external_document_id
getLatestPdfId()  : string
Gets latest_pdf_id
getName()  : string
Gets name
getPages()  : int
Gets pages
getters()  : mixed
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.
setAttachmentDescription()  : $this
Sets attachment_description
setDocumentId()  : $this
Sets document_id
setDocumentType()  : $this
Sets document_type
setEnvelopeId()  : $this
Sets envelope_id
setExternalDocumentId()  : $this
Sets external_document_id
setLatestPdfId()  : $this
Sets latest_pdf_id
setName()  : $this
Sets name
setPages()  : $this
Sets pages
setters()  : mixed
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 = ['attachment_description' => 'attachmentDescription', 'document_id' => 'documentId', 'document_type' => 'documentType', 'envelope_id' => 'envelopeId', 'external_document_id' => 'externalDocumentId', 'latest_pdf_id' => 'latestPDFId', 'name' => 'name', 'pages' => 'pages']

$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 = ['attachment_description' => 'getAttachmentDescription', 'document_id' => 'getDocumentId', 'document_type' => 'getDocumentType', 'envelope_id' => 'getEnvelopeId', 'external_document_id' => 'getExternalDocumentId', 'latest_pdf_id' => 'getLatestPdfId', 'name' => 'getName', 'pages' => 'getPages']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['attachment_description' => 'setAttachmentDescription', 'document_id' => 'setDocumentId', 'document_type' => 'setDocumentType', 'envelope_id' => 'setEnvelopeId', 'external_document_id' => 'setExternalDocumentId', 'latest_pdf_id' => 'setLatestPdfId', 'name' => 'setName', 'pages' => 'setPages']

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'displayApplianceDocument'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['attachment_description' => 'string', 'document_id' => 'string', 'document_type' => 'string', 'envelope_id' => 'string', 'external_document_id' => 'string', 'latest_pdf_id' => 'string', 'name' => 'string', 'pages' => 'int']

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 —

getAttachmentDescription()

Gets attachment_description

public getAttachmentDescription() : string
Return values
string —

getExternalDocumentId()

Gets external_document_id

public getExternalDocumentId() : 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 —

setAttachmentDescription()

Sets attachment_description

public setAttachmentDescription(string $attachment_description) : $this
Parameters
$attachment_description : string
Return values
$this —

setDocumentId()

Sets document_id

public setDocumentId(string $document_id) : $this
Parameters
$document_id : string

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

Return values
$this —

setDocumentType()

Sets document_type

public setDocumentType(string $document_type) : $this
Parameters
$document_type : string
Return values
$this —

setEnvelopeId()

Sets envelope_id

public setEnvelopeId(string $envelope_id) : $this
Parameters
$envelope_id : string

The envelope ID of the envelope status that failed to post.

Return values
$this —

setExternalDocumentId()

Sets external_document_id

public setExternalDocumentId(string $external_document_id) : $this
Parameters
$external_document_id : string
Return values
$this —

setLatestPdfId()

Sets latest_pdf_id

public setLatestPdfId(string $latest_pdf_id) : $this
Parameters
$latest_pdf_id : string
Return values
$this —

setName()

Sets name

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

setPages()

Sets pages

public setPages(int $pages) : $this
Parameters
$pages : int
Return values
$this —

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