Class SceneViewStatesApi

SceneViewStatesApi - object-oriented interface

export

Hierarchy

BaseAPI
- SceneViewStatesApi

Index

Constructors

constructor

Methods

Constructors

constructor

new SceneViewStatesApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): SceneViewStatesApi

Inherited from BaseAPI.constructor
- Defined in base.ts:51
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SceneViewStatesApi

Methods

createSceneViewState

createSceneViewState(requestParameters: SceneViewStatesApiCreateSceneViewStateRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<SceneViewState, any>>

- Defined in api.ts:15270
Create a scene-view-state for a scene.

throws
{RequiredError}

memberof
SceneViewStatesApi

Parameters
- requestParameters: SceneViewStatesApiCreateSceneViewStateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<SceneViewState, any>>

deleteSceneViewState

deleteSceneViewState(requestParameters: SceneViewStatesApiDeleteSceneViewStateRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<void, any>>

- Defined in api.ts:15290
Delete a scene-view-state.

throws
{RequiredError}

memberof
SceneViewStatesApi

Parameters
- requestParameters: SceneViewStatesApiDeleteSceneViewStateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<void, any>>

getSceneViewState

getSceneViewState(requestParameters: SceneViewStatesApiGetSceneViewStateRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<SceneViewState, any>>

- Defined in api.ts:15306
Get a scene-view-state by ID.

throws
{RequiredError}

memberof
SceneViewStatesApi

Parameters
- requestParameters: SceneViewStatesApiGetSceneViewStateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<SceneViewState, any>>

getSceneViewStates

getSceneViewStates(requestParameters: SceneViewStatesApiGetSceneViewStatesRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<SceneViewStateList, any>>

- Defined in api.ts:15326
Get scene-view-states for a scene.

throws
{RequiredError}

memberof
SceneViewStatesApi

Parameters
- requestParameters: SceneViewStatesApiGetSceneViewStatesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<SceneViewStateList, any>>

updateSceneViewState

updateSceneViewState(requestParameters: SceneViewStatesApiUpdateSceneViewStateRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<SceneViewState, any>>

- Defined in api.ts:15350
Update a scene-view-state.

throws
{RequiredError}

memberof
SceneViewStatesApi

Parameters
- requestParameters: SceneViewStatesApiUpdateSceneViewStateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<SceneViewState, any>>