Documentation

DisplayAppliancePage
in package
implements ArrayAccess

DisplayAppliancePage 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
getDocumentId()  : string
Gets document_id
getDocumentName()  : string
Gets document_name
getExternalDocumentId()  : string
Gets external_document_id
getHeight()  : int
Gets height
getIsFirstPage()  : bool
Gets is_first_page
getPageId()  : string
Gets page_id
getPageNo()  : int
Gets page_no
getPageStatus()  : string
Gets page_status
getPageType()  : string
Gets page_type
getters()  : mixed
getWidth()  : int
Gets width
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.
setDocumentId()  : $this
Sets document_id
setDocumentName()  : $this
Sets document_name
setExternalDocumentId()  : $this
Sets external_document_id
setHeight()  : $this
Sets height
setIsFirstPage()  : $this
Sets is_first_page
setPageId()  : $this
Sets page_id
setPageNo()  : $this
Sets page_no
setPageStatus()  : $this
Sets page_status
setPageType()  : $this
Sets page_type
setters()  : mixed
setWidth()  : $this
Sets width
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 = ['document_id' => 'documentId', 'document_name' => 'documentName', 'external_document_id' => 'externalDocumentId', 'height' => 'height', 'is_first_page' => 'isFirstPage', 'page_id' => 'pageId', 'page_no' => 'pageNo', 'page_status' => 'pageStatus', 'page_type' => 'pageType', 'width' => 'width']

$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 = ['document_id' => 'getDocumentId', 'document_name' => 'getDocumentName', 'external_document_id' => 'getExternalDocumentId', 'height' => 'getHeight', 'is_first_page' => 'getIsFirstPage', 'page_id' => 'getPageId', 'page_no' => 'getPageNo', 'page_status' => 'getPageStatus', 'page_type' => 'getPageType', 'width' => 'getWidth']

$setters

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

protected static array<string|int, string> $setters = ['document_id' => 'setDocumentId', 'document_name' => 'setDocumentName', 'external_document_id' => 'setExternalDocumentId', 'height' => 'setHeight', 'is_first_page' => 'setIsFirstPage', 'page_id' => 'setPageId', 'page_no' => 'setPageNo', 'page_status' => 'setPageStatus', 'page_type' => 'setPageType', 'width' => 'setWidth']

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'displayAppliancePage'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['document_id' => 'string', 'document_name' => 'string', 'external_document_id' => 'string', 'height' => 'int', 'is_first_page' => 'bool', 'page_id' => 'string', 'page_no' => 'int', 'page_status' => 'string', 'page_type' => 'string', 'width' => '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

getDocumentId()

Gets document_id

public getDocumentId() : string
Return values
string

getDocumentName()

Gets document_name

public getDocumentName() : string
Return values
string

getExternalDocumentId()

Gets external_document_id

public getExternalDocumentId() : string
Return values
string

getIsFirstPage()

Gets is_first_page

public getIsFirstPage() : bool
Return values
bool

getPageStatus()

Gets page_status

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

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

setDocumentName()

Sets document_name

public setDocumentName(string $document_name) : $this
Parameters
$document_name : string
Return values
$this

setExternalDocumentId()

Sets external_document_id

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

setHeight()

Sets height

public setHeight(int $height) : $this
Parameters
$height : int

Height of the tab in pixels.

Return values
$this

setIsFirstPage()

Sets is_first_page

public setIsFirstPage(bool $is_first_page) : $this
Parameters
$is_first_page : bool
Return values
$this

setPageId()

Sets page_id

public setPageId(string $page_id) : $this
Parameters
$page_id : string
Return values
$this

setPageNo()

Sets page_no

public setPageNo(int $page_no) : $this
Parameters
$page_no : int
Return values
$this

setPageStatus()

Sets page_status

public setPageStatus(string $page_status) : $this
Parameters
$page_status : string
Return values
$this

setPageType()

Sets page_type

public setPageType(string $page_type) : $this
Parameters
$page_type : string
Return values
$this

setWidth()

Sets width

public setWidth(int $width) : $this
Parameters
$width : int

Width of the tab in pixels.

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