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

GetNextUpRequest

@Serializable

data class GetNextUpRequest(val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val seriesId: UUID? = null, val parentId: UUID? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null, val nextUpDateCutoff: DateTime? = null, val enableTotalRecordCount: Boolean? = true, val enableResumable: Boolean? = true, val enableRewatching: Boolean? = false)

A list of next up episodes.

Constructors

GetNextUpRequest

constructor(userId: UUID? = null, startIndex: Int? = null, limit: Int? = null, fields: Collection<ItemFields>? = null, seriesId: UUID? = null, parentId: UUID? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = null, enableUserData: Boolean? = null, nextUpDateCutoff: DateTime? = null, enableTotalRecordCount: Boolean? = true, enableResumable: Boolean? = true, enableRewatching: Boolean? = false)

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.

enableResumable

@SerialName(value = "enableResumable")

val enableResumable: Boolean?

Whether to include resumable episodes in next up results.

enableRewatching

@SerialName(value = "enableRewatching")

val enableRewatching: Boolean?

Whether to include watched episodes in next up results.

enableTotalRecordCount

@SerialName(value = "enableTotalRecordCount")

val enableTotalRecordCount: Boolean?

Whether to enable the total records count. Defaults to true.

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

nextUpDateCutoff

@SerialName(value = "nextUpDateCutoff")

val nextUpDateCutoff: DateTime?

Optional. Starting date of shows to show in Next Up section.

@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 = "seriesId")

val seriesId: UUID?

Optional. Filter by series id.

@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 next up episodes for.