@jellyfin/sdk
    Preparing search index...

    Interface TvShowsApiGetSeasonsRequest

    Request parameters for getSeasons operation in TvShowsApi.

    TvShowsApiGetSeasonsRequest

    interface TvShowsApiGetSeasonsRequest {
        adjacentTo?: string;
        enableImages?: boolean;
        enableImageTypes?: ImageType[];
        enableUserData?: boolean;
        fields?: ItemFields[];
        imageTypeLimit?: number;
        isMissing?: boolean;
        isSpecialSeason?: boolean;
        seriesId: string;
        userId?: string;
    }
    Index

    Properties

    adjacentTo? enableImages? enableImageTypes? enableUserData? fields? imageTypeLimit? isMissing? isSpecialSeason? seriesId userId?

    Properties

    adjacentTo?: string

    Optional. Return items that are siblings of a supplied item.

    TvShowsApiGetSeasons

    enableImages?: boolean

    Optional. Include image information in output.

    TvShowsApiGetSeasons

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    TvShowsApiGetSeasons

    enableUserData?: boolean

    Optional. Include user data.

    TvShowsApiGetSeasons

    fields?: ItemFields[]

    Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

    TvShowsApiGetSeasons

    imageTypeLimit?: number

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

    TvShowsApiGetSeasons

    isMissing?: boolean

    Optional. Filter by items that are missing episodes or not.

    TvShowsApiGetSeasons

    isSpecialSeason?: boolean

    Optional. Filter by special season.

    TvShowsApiGetSeasons

    seriesId: string

    The series id.

    TvShowsApiGetSeasons

    userId?: string

    The user id.

    TvShowsApiGetSeasons

    Settings

    Member Visibility

    On This Page

    Properties