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

    Type Alias GetQueryFiltersData

    type GetQueryFiltersData = {
        body?: never;
        path?: never;
        query?: {
            userId?: string;
            parentId?: string;
            includeItemTypes?: BaseItemKind[];
            isAiring?: boolean;
            isMovie?: boolean;
            isSports?: boolean;
            isKids?: boolean;
            isNews?: boolean;
            isSeries?: boolean;
            recursive?: boolean;
        };
        url: "/Items/Filters2";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: never
    path?: never
    query?: {
        userId?: string;
        parentId?: string;
        includeItemTypes?: BaseItemKind[];
        isAiring?: boolean;
        isMovie?: boolean;
        isSports?: boolean;
        isKids?: boolean;
        isNews?: boolean;
        isSeries?: boolean;
        recursive?: boolean;
    }

    Type Declaration

    • OptionaluserId?: string

      Optional. User id.

    • OptionalparentId?: string

      Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.

    • OptionalincludeItemTypes?: BaseItemKind[]

      Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

    • OptionalisAiring?: boolean

      Optional. Is item airing.

    • OptionalisMovie?: boolean

      Optional. Is item movie.

    • OptionalisSports?: boolean

      Optional. Is item sports.

    • OptionalisKids?: boolean

      Optional. Is item kids.

    • OptionalisNews?: boolean

      Optional. Is item news.

    • OptionalisSeries?: boolean

      Optional. Is item series.

    • Optionalrecursive?: boolean

      Optional. Search recursive.

    url: "/Items/Filters2"

    Settings
    Member Visibility

    On This Page
    Properties