Documentation

AddActionRequest

in package

• BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable

AddActionRequest Class Doc Comment

Tags

category

Class

author

OpenAPI Generator team

link

https://openapi-generator.tech

implements

Table of Contents

Interfaces

ModelInterface

Interface abstracting model access.

ArrayAccess

JsonSerializable

Constants

DISCRIMINATOR  : mixed = null

MAIN_TYPE_BCOL  : mixed = 'BCOL'

MAIN_TYPE_BSL  : mixed = 'BSL'

MAIN_TYPE_BUL  : mixed = 'BUL'

MAIN_TYPE_BVL  : mixed = 'BVL'

MAIN_TYPE_CHECK3  : mixed = 'CHECK3'

MAIN_TYPE_CLASH  : mixed = 'CLASH'

MAIN_TYPE_FOLDER  : mixed = 'FOLDER'

MAIN_TYPE_IDS  : mixed = 'IDS'

MAIN_TYPE_QUERY3  : mixed = 'QUERY3'

OUTPUT_HINT_JSON_VIEW  : mixed = 'JSON_VIEW'

OUTPUT_HINT_POPUP_VIEW  : mixed = 'POPUP_VIEW'

OUTPUT_HINT_TABLE_VIEW  : mixed = 'TABLE_VIEW'

OUTPUT_HINT_TAKEOFF  : mixed = 'TAKEOFF'

OUTPUT_HINT_VIEWER_2_D  : mixed = 'VIEWER_2D'

OUTPUT_HINT_VIEWER_3_D  : mixed = 'VIEWER_3D'

Properties

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

$openAPIFormats  : array<string|int, string>

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

$openAPIModelName  : string

The original name of the model.

$openAPINullables  : array<string|int, bool>

Array of nullable properties. Used for (de)serialization

$openAPINullablesSetToNull  : array<string|int, bool>

If a nullable field gets set to null, insert it here

$openAPITypes  : array<string|int, string>

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

$setters  : array<string|int, string>

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

Methods

__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

getDescription()  : string|null

Gets description

getFavourite()  : bool|null

Gets favourite

getIconName()  : string|null

Gets icon_name

getMainType()  : string

Gets main_type

getMainTypeAllowableValues()  : array<string|int, string>

Gets allowable values of the enum

getModelName()  : string

The original name of the model.

getName()  : string

Gets name

getOutputHint()  : string|null

Gets output_hint

getOutputHintAllowableValues()  : array<string|int, string>

Gets allowable values of the enum

getParentUuid()  : string

Gets parent_uuid

getQuery()  : string|null

Gets query

getSubType()  : string|null

Gets sub_type

getters()  : array<string|int, mixed>

Array of attributes to getter functions (for serialization of requests)

isNullable()  : bool

Checks if a property is nullable

isNullableSetToNull()  : bool

Checks if a nullable property is set to null.

jsonSerialize()  : mixed

Serializes the object to a value that can be serialized natively by json_encode().

listInvalidProperties()  : array<string|int, mixed>

Show all the invalid properties with reasons.

offsetExists()  : bool

Returns true if offset exists. False otherwise.

offsetGet()  : mixed|null

Gets offset.

offsetSet()  : void

Sets value based on offset.

offsetUnset()  : void

Unsets offset.

openAPIFormats()  : array<string|int, mixed>

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

openAPITypes()  : array<string|int, mixed>

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

setDescription()  : self

Sets description

setFavourite()  : self

Sets favourite

setIconName()  : self

Sets icon_name

setMainType()  : self

Sets main_type

setName()  : self

Sets name

setOutputHint()  : self

Sets output_hint

setParentUuid()  : self

Sets parent_uuid

setQuery()  : self

Sets query

setSubType()  : self

Sets sub_type

setters()  : array<string|int, mixed>

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

toHeaderValue()  : string

Gets a header-safe presentation of the object

valid()  : bool

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

openAPINullables()  : array<string|int, mixed>

Array of nullable properties

getOpenAPINullablesSetToNull()  : array<string|int, bool>

Array of nullable field names deliberately set to null

setIfExists()  : void

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array

setOpenAPINullablesSetToNull()  : void

Setter - Array of nullable field names deliberately set to null