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

    Type Alias GetNextUpData

    type GetNextUpData = {
        body?: never;
        path?: never;
        query?: {
            userId?: string;
            startIndex?: number;
            limit?: number;
            fields?: ItemFields[];
            seriesId?: string;
            parentId?: string;
            enableImages?: boolean;
            imageTypeLimit?: number;
            enableImageTypes?: ImageType[];
            enableUserData?: boolean;
            nextUpDateCutoff?: string;
            enableTotalRecordCount?: boolean;
            enableResumable?: boolean;
            enableRewatching?: boolean;
        };
        url: "/Shows/NextUp";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: never
    path?: never
    query?: {
        userId?: string;
        startIndex?: number;
        limit?: number;
        fields?: ItemFields[];
        seriesId?: string;
        parentId?: string;
        enableImages?: boolean;
        imageTypeLimit?: number;
        enableImageTypes?: ImageType[];
        enableUserData?: boolean;
        nextUpDateCutoff?: string;
        enableTotalRecordCount?: boolean;
        enableResumable?: boolean;
        enableRewatching?: boolean;
    }

    Type Declaration

    • OptionaluserId?: string

      The user id of the user to get the next up episodes for.

    • OptionalstartIndex?: number

      Optional. The record index to start at. All items with a lower index will be dropped from the results.

    • Optionallimit?: number

      Optional. The maximum number of records to return.

    • Optionalfields?: ItemFields[]

      Optional. Specify additional fields of information to return in the output.

    • OptionalseriesId?: string

      Optional. Filter by series id.

    • OptionalparentId?: string

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

    • OptionalenableImages?: boolean

      Optional. Include image information in output.

    • OptionalimageTypeLimit?: number

      Optional. The max number of images to return, per image type.

    • OptionalenableImageTypes?: ImageType[]

      Optional. The image types to include in the output.

    • OptionalenableUserData?: boolean

      Optional. Include user data.

    • OptionalnextUpDateCutoff?: string

      Optional. Starting date of shows to show in Next Up section.

    • OptionalenableTotalRecordCount?: boolean

      Whether to enable the total records count. Defaults to true.

    • OptionalenableResumable?: boolean

      Whether to include resumable episodes in next up results.

    • OptionalenableRewatching?: boolean

      Whether to include watched episodes in next up results.

    url: "/Shows/NextUp"

    Settings
    Member Visibility

    On This Page
    Properties