Function ItemRefreshApiFp

Returns {
    refreshItem(
        itemId: string,
        metadataRefreshMode?: MetadataRefreshMode,
        imageRefreshMode?: MetadataRefreshMode,
        replaceAllMetadata?: boolean,
        replaceAllImages?: boolean,
        regenerateTrickplay?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• refreshItem: function

  • refreshItem(
        itemId: string,
        metadataRefreshMode?: MetadataRefreshMode,
        imageRefreshMode?: MetadataRefreshMode,
        replaceAllMetadata?: boolean,
        replaceAllImages?: boolean,
        regenerateTrickplay?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • itemId: string

      Item id.

    • OptionalmetadataRefreshMode: MetadataRefreshMode

      (Optional) Specifies the metadata refresh mode.

    • OptionalimageRefreshMode: MetadataRefreshMode

      (Optional) Specifies the image refresh mode.

    • OptionalreplaceAllMetadata: boolean

      (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh.

    • OptionalreplaceAllImages: boolean

      (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.

    • OptionalregenerateTrickplay: boolean

      (Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws