Class StudiosApi

StudiosApi - object-oriented interface

Export

StudiosApi

Hierarchy

BaseAPI
- StudiosApi

Index

Constructors

Properties

axios basePath configuration

Methods

getStudio getStudios

Constructors

constructor

new StudiosApi(configuration?, basePath?, axios?): StudiosApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns StudiosApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getStudio

getStudio(requestParameters, options?): Promise<AxiosResponse<BaseItemDto, any>>
Parameters
- requestParameters: StudiosApiGetStudioRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any>>
Summary
Gets a studio by name.

Throws
Memberof
StudiosApi
- Defined in generated-client/api/studios-api.ts:447

getStudios

getStudios(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: StudiosApiGetStudiosRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets all studios from a given item, folder, or the entire library.

Throws
Memberof
StudiosApi
- Defined in generated-client/api/studios-api.ts:459