Function RemoteImageApiFactory

Returns {
    downloadRemoteImage(requestParameters: RemoteImageApiDownloadRemoteImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    getRemoteImageProviders(requestParameters: RemoteImageApiGetRemoteImageProvidersRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImageProviderInfo[]>;
    getRemoteImages(requestParameters: RemoteImageApiGetRemoteImagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<RemoteImageResult>;
}

• downloadRemoteImage:function

  • downloadRemoteImage(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: RemoteImageApiDownloadRemoteImageRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Downloads a remote image for an item.

    Throws

• getRemoteImageProviders:function

  • getRemoteImageProviders(requestParameters, options?): AxiosPromise<ImageProviderInfo[]>

  • Parameters

    • requestParameters: RemoteImageApiGetRemoteImageProvidersRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ImageProviderInfo[]>

    Summary

    Gets available remote image providers for an item.

    Throws

• getRemoteImages:function

  • getRemoteImages(requestParameters, options?): AxiosPromise<RemoteImageResult>

  • Parameters

    • requestParameters: RemoteImageApiGetRemoteImagesRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RemoteImageResult>

    Summary

    Gets available remote images for an item.

    Throws