GetSeasonsRequest

data class GetSeasonsRequest(val seriesId: UUID, val userId: UUID? = null, val fields: Collection<ItemFields>? = null, val isSpecialSeason: Boolean? = null, val isMissing: Boolean? = null, val adjacentTo: UUID? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null)

Seasons for a tv series.

Constructors

Link copied to clipboard
constructor(seriesId: UUID, userId: UUID? = null, fields: Collection<ItemFields>? = null, isSpecialSeason: Boolean? = null, isMissing: Boolean? = null, adjacentTo: UUID? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, enableUserData: Boolean? = null)

Properties

Link copied to clipboard
val adjacentTo: UUID? = null

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

Link copied to clipboard
val enableImages: Boolean? = null

Optional. Include image information in output.

Link copied to clipboard

Optional. The image types to include in the output.

Link copied to clipboard
val enableUserData: Boolean? = null

Optional. Include user data.

Link copied to clipboard

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.

Link copied to clipboard
val imageTypeLimit: Int? = null

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

Link copied to clipboard
val isMissing: Boolean? = null

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

Link copied to clipboard

Optional. Filter by special season.

Link copied to clipboard

The series id.

Link copied to clipboard
val userId: UUID? = null

The user id.