Class SceneItemOverridesApi

SceneItemOverridesApi - object-oriented interface

export

Hierarchy

BaseAPI
- SceneItemOverridesApi

Index

Constructors

constructor

Methods

Constructors

constructor

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

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

Methods

createSceneItemOverride

createSceneItemOverride(requestParameters: SceneItemOverridesApiCreateSceneItemOverrideRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<SceneItemOverride, any>>

- Defined in api.ts:13379
Create a scene-item-override for a scene-view.

throws
{RequiredError}

memberof
SceneItemOverridesApi

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

deleteSceneItemOverride

deleteSceneItemOverride(requestParameters: SceneItemOverridesApiDeleteSceneItemOverrideRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<void, any>>

- Defined in api.ts:13399
Delete a scene-item-override.

throws
{RequiredError}

memberof
SceneItemOverridesApi

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

getSceneItemOverrides

getSceneItemOverrides(requestParameters: SceneItemOverridesApiGetSceneItemOverridesRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<SceneItemOverrideList, any>>

- Defined in api.ts:13415
Get scene-item-overrides for a scene-view.

throws
{RequiredError}

memberof
SceneItemOverridesApi

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

updateSceneItemOverride

updateSceneItemOverride(requestParameters: SceneItemOverridesApiUpdateSceneItemOverrideRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<SceneItemOverride, any>>

- Defined in api.ts:13436
Update a scene-item-override.

throws
{RequiredError}

memberof
SceneItemOverridesApi

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