Function RemoteImageApiAxiosParamCreator

RemoteImageApi - axios parameter creator

Export

  • RemoteImageApiAxiosParamCreator(configuration?): {
        downloadRemoteImage: ((itemId: string, type: ImageType, imageUrl?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getRemoteImageProviders: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getRemoteImages: ((itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        downloadRemoteImage: ((itemId: string, type: ImageType, imageUrl?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getRemoteImageProviders: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getRemoteImages: ((itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • downloadRemoteImage: ((itemId: string, type: ImageType, imageUrl?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Downloads a remote image for an item.

      Throws

        • (itemId, type, imageUrl?, options?): Promise<RequestArgs>

        • Parameters

          • itemId: string

            Item Id.

          • type: ImageType

            The image type.

          • OptionalimageUrl: string

            The image url.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getRemoteImageProviders: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets available remote image providers for an item.

      Throws

        • (itemId, options?): Promise<RequestArgs>

        • Parameters

          • itemId: string

            Item Id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getRemoteImages: ((itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets available remote images for an item.

      Throws

        • (itemId, type?, startIndex?, limit?, providerName?, includeAllLanguages?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

Settings

Member Visibility