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

    Type Alias AddVirtualFolderData

    type AddVirtualFolderData = {
        body?: AddVirtualFolderDto;
        path?: never;
        query?: {
            name?: string;
            collectionType?:
                | "movies"
                | "tvshows"
                | "music"
                | "musicvideos"
                | "homevideos"
                | "boxsets"
                | "books"
                | "mixed";
            paths?: string[];
            refreshLibrary?: boolean;
        };
        url: "/Library/VirtualFolders";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: AddVirtualFolderDto

    Add virtual folder dto.

    path?: never
    query?: {
        name?: string;
        collectionType?:
            | "movies"
            | "tvshows"
            | "music"
            | "musicvideos"
            | "homevideos"
            | "boxsets"
            | "books"
            | "mixed";
        paths?: string[];
        refreshLibrary?: boolean;
    }

    Type Declaration

    • Optionalname?: string

      The name of the virtual folder.

    • OptionalcollectionType?:
          | "movies"
          | "tvshows"
          | "music"
          | "musicvideos"
          | "homevideos"
          | "boxsets"
          | "books"
          | "mixed"

      The type of the collection.

    • Optionalpaths?: string[]

      The paths of the virtual folder.

    • OptionalrefreshLibrary?: boolean

      Whether to refresh the library.

    url: "/Library/VirtualFolders"

    Settings
    Member Visibility

    On This Page
    Properties