@jellyfin/sdk
    Preparing search index...

    Interface TvShowsApiGetNextUpRequest

    Request parameters for getNextUp operation in TvShowsApi.

    TvShowsApiGetNextUpRequest

    interface TvShowsApiGetNextUpRequest {
        disableFirstEpisode?: boolean;
        enableImages?: boolean;
        enableImageTypes?: ImageType[];
        enableResumable?: boolean;
        enableRewatching?: boolean;
        enableTotalRecordCount?: boolean;
        enableUserData?: boolean;
        fields?: ItemFields[];
        imageTypeLimit?: number;
        limit?: number;
        nextUpDateCutoff?: string;
        parentId?: string;
        seriesId?: string;
        startIndex?: number;
        userId?: string;
    }
    Index

    Properties

    disableFirstEpisode? enableImages? enableImageTypes? enableResumable? enableRewatching? enableTotalRecordCount? enableUserData? fields? imageTypeLimit? limit? nextUpDateCutoff? parentId? seriesId? startIndex? userId?

    Properties

    disableFirstEpisode?: boolean

    Whether to disable sending the first episode in a series as next up.

    TvShowsApiGetNextUp

    enableImages?: boolean

    Optional. Include image information in output.

    TvShowsApiGetNextUp

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    TvShowsApiGetNextUp

    enableResumable?: boolean

    Whether to include resumable episodes in next up results.

    TvShowsApiGetNextUp

    enableRewatching?: boolean

    Whether to include watched episodes in next up results.

    TvShowsApiGetNextUp

    enableTotalRecordCount?: boolean

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

    TvShowsApiGetNextUp

    enableUserData?: boolean

    Optional. Include user data.

    TvShowsApiGetNextUp

    fields?: ItemFields[]

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

    TvShowsApiGetNextUp

    imageTypeLimit?: number

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

    TvShowsApiGetNextUp

    limit?: number

    Optional. The maximum number of records to return.

    TvShowsApiGetNextUp

    nextUpDateCutoff?: string

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

    TvShowsApiGetNextUp

    parentId?: string

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

    TvShowsApiGetNextUp

    seriesId?: string

    Optional. Filter by series id.

    TvShowsApiGetNextUp

    startIndex?: number

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

    TvShowsApiGetNextUp

    userId?: string

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

    TvShowsApiGetNextUp

    Settings

    Member Visibility

    On This Page

    Properties