Documentation

ViewerApi
in package

ViewerApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

Constants

contentTypes  : array<string|int, string> = ['getGeometryMetaData' => ['application/json']]

Properties

$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int

Methods

__construct()  : mixed
getConfig()  : Configuration
getGeometryMetaData()  : array<string, array<string, mixed>>|ErrorResponse
Operation getGeometryMetaData
getGeometryMetaDataAsync()  : PromiseInterface
Operation getGeometryMetaDataAsync
getGeometryMetaDataAsyncWithHttpInfo()  : PromiseInterface
Operation getGeometryMetaDataAsyncWithHttpInfo
getGeometryMetaDataRequest()  : Request
Create request for operation 'getGeometryMetaData'
getGeometryMetaDataWithHttpInfo()  : array<string|int, mixed>
Operation getGeometryMetaDataWithHttpInfo
getHostIndex()  : int
Get the host index
setHostIndex()  : void
Set the host index
createHttpClientOption()  : array<string|int, mixed>
Create http client option
handleResponseWithDataType()  : array<string|int, mixed>
responseWithinRangeCode()  : bool

Constants

contentTypes

public array<string|int, string> contentTypes = ['getGeometryMetaData' => ['application/json']]

Properties

$hostIndex

protected int $hostIndex

Host index

Methods

__construct()

public __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed
Parameters
$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

getGeometryMetaData()

Operation getGeometryMetaData

public getGeometryMetaData(GetGeometryMetaDataRequest $get_geometry_meta_data_request[, string $contentType = self::contentTypes['getGeometryMetaData'][0] ]) : array<string, array<string, mixed>>|ErrorResponse

What a viewer needs to place and load models

Parameters
$get_geometry_meta_data_request : GetGeometryMetaDataRequest

get_geometry_meta_data_request (required)

$contentType : string = self::contentTypes['getGeometryMetaData'][0]

The value for the Content-Type header. Check self::contentTypes['getGeometryMetaData'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
array<string, array<string, mixed>>|ErrorResponse

getGeometryMetaDataAsync()

Operation getGeometryMetaDataAsync

public getGeometryMetaDataAsync(GetGeometryMetaDataRequest $get_geometry_meta_data_request[, string $contentType = self::contentTypes['getGeometryMetaData'][0] ]) : PromiseInterface

What a viewer needs to place and load models

Parameters
$get_geometry_meta_data_request : GetGeometryMetaDataRequest

(required)

$contentType : string = self::contentTypes['getGeometryMetaData'][0]

The value for the Content-Type header. Check self::contentTypes['getGeometryMetaData'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getGeometryMetaDataAsyncWithHttpInfo()

Operation getGeometryMetaDataAsyncWithHttpInfo

public getGeometryMetaDataAsyncWithHttpInfo(GetGeometryMetaDataRequest $get_geometry_meta_data_request[, string $contentType = self::contentTypes['getGeometryMetaData'][0] ]) : PromiseInterface

What a viewer needs to place and load models

Parameters
$get_geometry_meta_data_request : GetGeometryMetaDataRequest

(required)

$contentType : string = self::contentTypes['getGeometryMetaData'][0]

The value for the Content-Type header. Check self::contentTypes['getGeometryMetaData'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getGeometryMetaDataRequest()

Create request for operation 'getGeometryMetaData'

public getGeometryMetaDataRequest(GetGeometryMetaDataRequest $get_geometry_meta_data_request[, string $contentType = self::contentTypes['getGeometryMetaData'][0] ]) : Request
Parameters
$get_geometry_meta_data_request : GetGeometryMetaDataRequest

(required)

$contentType : string = self::contentTypes['getGeometryMetaData'][0]

The value for the Content-Type header. Check self::contentTypes['getGeometryMetaData'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getGeometryMetaDataWithHttpInfo()

Operation getGeometryMetaDataWithHttpInfo

public getGeometryMetaDataWithHttpInfo(GetGeometryMetaDataRequest $get_geometry_meta_data_request[, string $contentType = self::contentTypes['getGeometryMetaData'][0] ]) : array<string|int, mixed>

What a viewer needs to place and load models

Parameters
$get_geometry_meta_data_request : GetGeometryMetaDataRequest

(required)

$contentType : string = self::contentTypes['getGeometryMetaData'][0]

The value for the Content-Type header. Check self::contentTypes['getGeometryMetaData'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
array<string|int, mixed> —

of array<string,array<string,mixed>>|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse|\BIMworks\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int —

Host index

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed> —

of http client options

handleResponseWithDataType()

private handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>
Parameters
$dataType : string
$request : RequestInterface
$response : ResponseInterface
Return values
array<string|int, mixed>

responseWithinRangeCode()

private responseWithinRangeCode(string $rangeCode, int $statusCode) : bool
Parameters
$rangeCode : string
$statusCode : int
Return values
bool
On this page

Search results