Class RemoteImageApi

RemoteImageApi - object-oriented interface

Export

RemoteImageApi

Hierarchy

BaseAPI
- RemoteImageApi

Index

Constructors

Properties

axios basePath configuration

Methods

downloadRemoteImage getRemoteImageProviders getRemoteImages

Constructors

constructor

new RemoteImageApi(configuration?, basePath?, axios?): RemoteImageApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns RemoteImageApi
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

downloadRemoteImage

downloadRemoteImage(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: RemoteImageApiDownloadRemoteImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Downloads a remote image for an item.

Throws
Memberof
RemoteImageApi
- Defined in generated-client/api/remote-image-api.ts:390

getRemoteImageProviders

getRemoteImageProviders(requestParameters, options?): Promise<AxiosResponse<ImageProviderInfo[], any>>
Parameters
- requestParameters: RemoteImageApiGetRemoteImageProvidersRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ImageProviderInfo[], any>>
Summary
Gets available remote image providers for an item.

Throws
Memberof
RemoteImageApi
- Defined in generated-client/api/remote-image-api.ts:402

getRemoteImages

getRemoteImages(requestParameters, options?): Promise<AxiosResponse<RemoteImageResult, any>>
Parameters
- requestParameters: RemoteImageApiGetRemoteImagesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteImageResult, any>>
Summary
Gets available remote images for an item.

Throws
Memberof
RemoteImageApi
- Defined in generated-client/api/remote-image-api.ts:414