Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias RefreshItemData

    type RefreshItemData = {
        body?: never;
        path: { itemId: string };
        query?: {
            metadataRefreshMode?:
                | "None"
                | "ValidationOnly"
                | "Default"
                | "FullRefresh";
            imageRefreshMode?: "None"
            | "ValidationOnly"
            | "Default"
            | "FullRefresh";
            replaceAllMetadata?: boolean;
            replaceAllImages?: boolean;
            regenerateTrickplay?: boolean;
        };
        url: "/Items/{itemId}/Refresh";
    }
    Index
    body? path query? url

    Optionalbody

    body?: never
    path: { itemId: string }

    Type Declaration

    • itemId: string

      Item id.

    query?: {
        metadataRefreshMode?:
            | "None"
            | "ValidationOnly"
            | "Default"
            | "FullRefresh";
        imageRefreshMode?: "None"
        | "ValidationOnly"
        | "Default"
        | "FullRefresh";
        replaceAllMetadata?: boolean;
        replaceAllImages?: boolean;
        regenerateTrickplay?: boolean;
    }

    Type Declaration

    • OptionalmetadataRefreshMode?: "None" | "ValidationOnly" | "Default" | "FullRefresh"

      (Optional) Specifies the metadata refresh mode.

    • OptionalimageRefreshMode?: "None" | "ValidationOnly" | "Default" | "FullRefresh"

      (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.

    url: "/Items/{itemId}/Refresh"

    Settings
    Member Visibility

    On This Page
    Properties