Function RemoteImageApiFp

Returns {
    downloadRemoteImage(
        itemId: string,
        type: ImageType,
        imageUrl?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    getRemoteImageProviders(
        itemId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ImageProviderInfo[]>,
    >;
    getRemoteImages(
        itemId: string,
        type?: ImageType,
        startIndex?: number,
        limit?: number,
        providerName?: string,
        includeAllLanguages?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RemoteImageResult>,
    >;
}

• downloadRemoteImage: function

  • downloadRemoteImage(
        itemId: string,
        type: ImageType,
        imageUrl?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • itemId: string

      Item Id.

    • type: ImageType

      The image type.

    • OptionalimageUrl: string

      The image url.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• getRemoteImageProviders: function

  • getRemoteImageProviders(
        itemId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ImageProviderInfo[]>,
    >

    Parameters

    • itemId: string

      Item Id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ImageProviderInfo[]>,
    >

    Throws

• getRemoteImages: function

  • getRemoteImages(
        itemId: string,
        type?: ImageType,
        startIndex?: number,
        limit?: number,
        providerName?: string,
        includeAllLanguages?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RemoteImageResult>,
    >

    Parameters

    • itemId: string

      Item Id.

    • Optionaltype: ImageType

      The image type.

    • OptionalstartIndex: number

      Optional. The record index to start at. All items with a lower index will be dropped from the results.

    • Optionallimit: number

      Optional. The maximum number of records to return.

    • OptionalproviderName: string

      Optional. The image provider to use.

    • OptionalincludeAllLanguages: boolean

      Optional. Include all languages.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RemoteImageResult>,
    >

    Throws