Class RemoteImageApi

RemoteImageApi - object-oriented interface

Export

RemoteImageApi

Hierarchy

BaseAPI
- RemoteImageApi

Index

Constructors

Methods

downloadRemoteImage getRemoteImageProviders getRemoteImages

Constructors

constructor

new RemoteImageApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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: RemoteImageApiDownloadRemoteImageRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: RemoteImageApiDownloadRemoteImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
RemoteImageApi
- Defined in generated-client/api/remote-image-api.ts:390

getRemoteImageProviders

getRemoteImageProviders(
requestParameters: RemoteImageApiGetRemoteImageProvidersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ImageProviderInfo[], any>>
Parameters
- requestParameters: RemoteImageApiGetRemoteImageProvidersRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ImageProviderInfo[], any>>
Throws
Memberof
RemoteImageApi
- Defined in generated-client/api/remote-image-api.ts:402

getRemoteImages

getRemoteImages(
requestParameters: RemoteImageApiGetRemoteImagesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoteImageResult, any>>
Parameters
- requestParameters: RemoteImageApiGetRemoteImagesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteImageResult, any>>
Throws
Memberof
RemoteImageApi
- Defined in generated-client/api/remote-image-api.ts:414