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

    Type Alias VirtualFolderInfo

    Used to hold information about a user's list of configured virtual folders.

    type VirtualFolderInfo = {
        Name?: string | null;
        Locations?: string[] | null;
        CollectionType?:
            | "movies"
            | "tvshows"
            | "music"
            | "musicvideos"
            | "homevideos"
            | "boxsets"
            | "books"
            | "mixed";
        LibraryOptions?: LibraryOptions
        | null;
        ItemId?: string | null;
        PrimaryImageItemId?: string | null;
        RefreshProgress?: number | null;
        RefreshStatus?: string | null;
    }
    Index
    Name? Locations? CollectionType? LibraryOptions? ItemId? PrimaryImageItemId? RefreshProgress? RefreshStatus?
    Name?: string | null

    Gets or sets the name.

    Locations?: string[] | null

    Gets or sets the locations.

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

    Gets or sets the type of the collection.

    LibraryOptions?: LibraryOptions | null
    ItemId?: string | null

    Gets or sets the item identifier.

    PrimaryImageItemId?: string | null

    Gets or sets the primary image item identifier.

    RefreshProgress?: number | null
    RefreshStatus?: string | null

    Settings
    Member Visibility

    On This Page
    Properties