Interface TvShowsApiGetEpisodesRequest

Request parameters for getEpisodes operation in TvShowsApi.

Export

TvShowsApiGetEpisodesRequest

interface TvShowsApiGetEpisodesRequest {
    adjacentTo?: string;
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableUserData?: boolean;
    fields?: ItemFields[];
    imageTypeLimit?: number;
    isMissing?: boolean;
    limit?: number;
    season?: number;
    seasonId?: string;
    seriesId: string;
    sortBy?: ItemSortBy;
    startIndex?: number;
    startItemId?: string;
    userId?: string;
}

Properties

adjacentTo? enableImages? enableImageTypes? enableUserData? fields? imageTypeLimit? isMissing? limit? season? seasonId? seriesId sortBy? startIndex? startItemId? userId?

Properties

Optional ReadonlyadjacentTo

adjacentTo?: string

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

Memberof

TvShowsApiGetEpisodes

Optional ReadonlyenableImages

enableImages?: boolean

Optional, include image information in output.

Memberof

TvShowsApiGetEpisodes

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

TvShowsApiGetEpisodes

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. Include user data.

Memberof

TvShowsApiGetEpisodes

Optional Readonlyfields

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.

Memberof

TvShowsApiGetEpisodes

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

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

Memberof

TvShowsApiGetEpisodes

Optional ReadonlyisMissing

isMissing?: boolean

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

Memberof

TvShowsApiGetEpisodes

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

TvShowsApiGetEpisodes

Optional Readonlyseason

season?: number

Optional filter by season number.

Memberof

TvShowsApiGetEpisodes

Optional ReadonlyseasonId

seasonId?: string

Optional. Filter by season id.

Memberof

TvShowsApiGetEpisodes

ReadonlyseriesId

seriesId: string

The series id.

Memberof

TvShowsApiGetEpisodes

Optional ReadonlysortBy

sortBy?: ItemSortBy

Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

Memberof

TvShowsApiGetEpisodes

Optional ReadonlystartIndex

startIndex?: number

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

Memberof

TvShowsApiGetEpisodes

Optional ReadonlystartItemId

startItemId?: string

Optional. Skip through the list until a given item is found.

Memberof

TvShowsApiGetEpisodes

Optional ReadonlyuserId

userId?: string

The user id.

Memberof

TvShowsApiGetEpisodes

Settings

Member Visibility

On This Page

Properties