jellyfin-model/org.jellyfin.sdk.model.api.request/GetEpisodesRequest

GetEpisodesRequest

data class GetEpisodesRequest(val seriesId: UUID, val userId: UUID? = null, val fields: Collection<ItemFields>? = null, val season: Int? = null, val seasonId: UUID? = null, val isMissing: Boolean? = null, val adjacentTo: UUID? = null, val startItemId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null, val sortBy: ItemSortBy? = null)

Episodes for a tv season.

Constructors

GetEpisodesRequest

constructor(seriesId: UUID, userId: UUID? = null, fields: Collection<ItemFields>? = null, season: Int? = null, seasonId: UUID? = null, isMissing: Boolean? = null, adjacentTo: UUID? = null, startItemId: UUID? = null, startIndex: Int? = null, limit: Int? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, enableUserData: Boolean? = null, sortBy: ItemSortBy? = null)

Properties

adjacentTo

val adjacentTo: UUID?

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

enableImages

val enableImages: Boolean?

Optional, include image information in output.

enableImageTypes

val enableImageTypes: Collection<ImageType>?

Optional. The image types to include in the output.

enableUserData

val enableUserData: Boolean?

Optional. Include user data.

fields

val fields: Collection<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.

imageTypeLimit

val imageTypeLimit: Int?

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

isMissing

val isMissing: Boolean?

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

limit

val limit: Int?

Optional. The maximum number of records to return.

season

val season: Int?

Optional filter by season number.

seasonId

val seasonId: UUID?

Optional. Filter by season id.

seriesId

val seriesId: UUID

The series id.

sortBy

val 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.

startIndex

val startIndex: Int?

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

startItemId

val startItemId: UUID?

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

userId

val userId: UUID?

The user id.