GetSeasonsRequest

@Serializable
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
@SerialName(value = "adjacentTo")
val adjacentTo: UUID?

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

Link copied to clipboard
@SerialName(value = "enableImages")
val enableImages: Boolean?

Optional. Include image information in output.

Link copied to clipboard
@SerialName(value = "enableImageTypes")
val enableImageTypes: Collection<ImageType>?

Optional. The image types to include in the output.

Link copied to clipboard
@SerialName(value = "enableUserData")
val enableUserData: Boolean?

Optional. Include user data.

Link copied to clipboard
@SerialName(value = "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.

Link copied to clipboard
@SerialName(value = "imageTypeLimit")
val imageTypeLimit: Int?

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

Link copied to clipboard
@SerialName(value = "isMissing")
val isMissing: Boolean?

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

Link copied to clipboard
@SerialName(value = "isSpecialSeason")
val isSpecialSeason: Boolean?

Optional. Filter by special season.

Link copied to clipboard
@SerialName(value = "seriesId")
val seriesId: UUID

The series id.

Link copied to clipboard
@SerialName(value = "userId")
val userId: UUID?

The user id.