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

GetUpcomingEpisodesRequest

@Serializable

data class GetUpcomingEpisodesRequest(val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val parentId: UUID? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null)

A list of upcoming episodes.

Constructors

GetUpcomingEpisodesRequest

constructor(userId: UUID? = null, startIndex: Int? = null, limit: Int? = null, fields: Collection<ItemFields>? = null, parentId: UUID? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, enableUserData: Boolean? = null)

Properties

@SerialName(value = "enableImages")

val enableImages: Boolean?

Optional. Include image information in output.

enableImageTypes

@SerialName(value = "enableImageTypes")

val enableImageTypes: Collection<ImageType>?

Optional. The image types to include in the output.

@SerialName(value = "enableUserData")

val enableUserData: Boolean?

Optional. Include user data.

@SerialName(value = "fields")

val fields: Collection<ItemFields>?

Optional. Specify additional fields of information to return in the output.

@SerialName(value = "imageTypeLimit")

val imageTypeLimit: Int?

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

@SerialName(value = "limit")

val limit: Int?

Optional. The maximum number of records to return.

@SerialName(value = "parentId")

val parentId: UUID?

Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.

@SerialName(value = "startIndex")

val startIndex: Int?

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

@SerialName(value = "userId")

val userId: UUID?

The user id of the user to get the upcoming episodes for.